Skip to content

Modernize the iOS Voice Settings catalogue - #294

Merged
RDMurray merged 7 commits into
mainfrom
agent/voice-settings-catalogue
Jul 27, 2026
Merged

Modernize the iOS Voice Settings catalogue#294
RDMurray merged 7 commits into
mainfrom
agent/voice-settings-catalogue

Conversation

@RDMurray

@RDMurray RDMurray commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the storyboard-based Voice Settings screen with SwiftUI
  • organize voices into locale sections and collapsed provider categories
  • place en-US novelty voices in a dedicated collapsed Novelty category
  • preserve the displayed locale order while the screen is open so VoiceOver focus is not disrupted by selection-driven reordering
  • retain voice preview, enhanced-voice guidance, speaking-rate controls, and selection state

Why

The previous storyboard implementation presented a long, difficult-to-navigate voice list and mixed rarely useful novelty and third-party voices with standard voices. Reordering the selected locale immediately also caused VoiceOver focus to land on a different row. The new catalogue makes the list easier to scan and keeps its structure stable during interaction.

Validation

  • xcodebuild test -project GuideDogs.xcodeproj -scheme Soundscape -destination 'platform=iOS Simulator,id=6D13394A-295B-4D57-B202-561E1E914E74' -only-testing:UnitTests/VoiceCatalogueTests CODE_SIGNING_ALLOWED=NO
  • 13 VoiceCatalogue tests passed
  • Soundscape app target built successfully as part of the test run
  • localization linter completed without errors

RDMurray added 3 commits July 26, 2026 22:26
Rebuild Voice Settings as a native SwiftUI list hosted from the UIKit Settings screen. Preserve voice selection and preview behavior, enhanced voice confirmation, speaking rate announcements, foreground refresh, telemetry, accessibility focus, and temporary callout and beacon muting.

Remove the legacy VoiceSettings storyboard, table controller, speaking rate cell, storyboard segue, and obsolete project references.

Automated testing:
- Soundscape Debug arm64 simulator build
- 66 UnitTests tests
- InterfaceBuilderAudit with no Voice Settings candidates or stale references

Manual testing required:
- Verify Settings > Voice navigation, localized sections, subtitles, checkmarks, preview spinner, enhanced voice alert, selection persistence, foreground voice refresh, and back navigation.
- Verify speaking-rate commit and delayed announcement, voice preview completion, and cancellation when leaving the screen.
- Verify callouts and beacon audio are muted only while Voice Settings is visible and restored afterward.
- Verify VoiceOver focus, traits, labels, and hints; Dynamic Type; and light/dark appearance colors.
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 89f4a3db-d69f-446e-a1b7-6c1c8570e2bc

📥 Commits

Reviewing files that changed from the base of the PR and between b744d88 and fe3d16d.

📒 Files selected for processing (5)
  • apps/ios/GuideDogs/Code/App/Framework Extensions/AVSpeech Extensions/AVSpeehSynthesisVoice+Extensions.swift
  • apps/ios/GuideDogs/Code/Audio/Text To Speech/TTSConfigHelper.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Language/LanguageSettingsView.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings/SettingsListBackground.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Voice/VoiceSettingsView.swift
💤 Files with no reviewable changes (1)
  • apps/ios/GuideDogs/Code/App/Framework Extensions/AVSpeech Extensions/AVSpeehSynthesisVoice+Extensions.swift

📝 Walkthrough

Summary by CodeRabbit

  • New Features
    • Added a redesigned Voice Settings screen with speaking-rate controls and voice previews.
    • Voices are now browsable grouped by language and provider, including new “Other Voices” and “Novelty” sections.
    • Voice Settings is accessible directly from the main Settings screen.
  • Bug Fixes
    • Improved voice availability filtering, locale-aware ordering, and fallback behavior when a saved voice is no longer available.

Walkthrough

The pull request replaces the storyboard voice settings screen with a SwiftUI voice catalogue, adds novelty/provider grouping and selection behavior, introduces catalogue tests and localization strings, and removes legacy voice settings storyboard and source references.

Changes

Voice settings catalogue

Layer / File(s) Summary
Voice catalogue domain and loading
apps/ios/GuideDogs/Code/App/Framework Extensions/..., apps/ios/GuideDogs/Code/Audio/Text To Speech/..., apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Voice/VoiceCatalogue.swift, apps/ios/UnitTests/Audio/VoiceCatalogueTests.swift
Voice identifiers support novelty detection, voice loading filters disallowed voices, and VoiceCatalogue groups voices by locale, provider, and novelty status with deterministic ordering and fallback selection rules. XCTest coverage validates these behaviors.
SwiftUI voice settings flow
apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Voice/VoiceSettingsView.swift, apps/ios/GuideDogs/Code/Visual UI/View Controllers/Settings/SettingsViewController.swift, apps/ios/GuideDogs/Assets/Localization/*.lproj/Localizable.strings, apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Language/LanguageSettingsView.swift, apps/ios/GuideDogs/Code/Visual UI/Views/Settings/SettingsListBackground.swift
A SwiftUI screen provides speaking-rate controls, provider and novelty disclosures, voice selection, previews, and VoiceOver announcements. Settings navigation, localized group labels, and shared list background handling are updated.
Legacy voice settings removal
apps/ios/GuideDogs/Code/Visual UI/Views/Settings.storyboard, apps/ios/GuideDogs/Code/Visual UI/Views/VoiceSettings.storyboard, apps/ios/GuideDogs/Code/Visual UI/View Controllers/Settings/Voice/VoiceSettingsTableViewController.swift, apps/ios/GuideDogs/Code/Visual UI/Controls/Voice Settings/SpeakingRateTableViewCell.swift, apps/ios/GuideDogs.xcodeproj/project.pbxproj
The storyboard voice segue and legacy voice settings scenes are removed, along with obsolete controller and speaking-rate cell project references. New test sources are registered in the Xcode project.

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: modernizing the iOS Voice Settings catalogue.
Description check ✅ Passed The description is directly related to the changeset and accurately describes the SwiftUI Voice Settings overhaul.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/ios/GuideDogs/Code/Visual`
UI/Views/Settings/Voice/VoiceSettingsView.swift:
- Around line 360-362: Update the voice dictionary construction in the
VoiceSettingsView loading flow to use a uniquing initializer instead of
Dictionary(uniqueKeysWithValues:), so duplicate identifiers from
TTSConfigHelper.loadVoices() no longer trap. Preserve the existing voice lookup
behavior and rebuildCatalogue() call.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 58898e86-a447-493f-9128-5b025a91643b

📥 Commits

Reviewing files that changed from the base of the PR and between 9d4b6e4 and b744d88.

📒 Files selected for processing (13)
  • apps/ios/GuideDogs.xcodeproj/project.pbxproj
  • apps/ios/GuideDogs/Assets/Localization/en-GB.lproj/Localizable.strings
  • apps/ios/GuideDogs/Assets/Localization/en-US.lproj/Localizable.strings
  • apps/ios/GuideDogs/Code/App/Framework Extensions/AVSpeech Extensions/AVSpeehSynthesisVoice+Extensions.swift
  • apps/ios/GuideDogs/Code/Audio/Text To Speech/TTSConfigHelper.swift
  • apps/ios/GuideDogs/Code/Visual UI/Controls/Voice Settings/SpeakingRateTableViewCell.swift
  • apps/ios/GuideDogs/Code/Visual UI/View Controllers/Settings/SettingsViewController.swift
  • apps/ios/GuideDogs/Code/Visual UI/View Controllers/Settings/Voice/VoiceSettingsTableViewController.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings.storyboard
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Voice/VoiceCatalogue.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings/Voice/VoiceSettingsView.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/VoiceSettings.storyboard
  • apps/ios/UnitTests/Audio/VoiceCatalogueTests.swift
💤 Files with no reviewable changes (4)
  • apps/ios/GuideDogs/Code/Visual UI/View Controllers/Settings/Voice/VoiceSettingsTableViewController.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/VoiceSettings.storyboard
  • apps/ios/GuideDogs/Code/Visual UI/Controls/Voice Settings/SpeakingRateTableViewCell.swift
  • apps/ios/GuideDogs/Code/Visual UI/Views/Settings.storyboard

@RDMurray

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@RDMurray
RDMurray merged commit f7663b7 into main Jul 27, 2026
2 checks passed
@RDMurray
RDMurray deleted the agent/voice-settings-catalogue branch July 27, 2026 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants